https://billing.iugu.com/api/customers/{id}/discounts
Aplica um desconto nas faturas emitidas do cliente em uma competência
Aplica um desconto nas faturas já emitidas do cliente para a competência informada. O desconto é aplicado apenas nas faturas das assinaturas do app que está fazendo a chamada. O valor informado não pode exceder o total restante dessas faturas.
Request
|
Path variables |
|
|---|---|
|
id
Required Type: string Identificador do workspace do cliente Ex: 4fHECmQtLdROI4fDLWMiLd |
|
|
Headers |
|
|---|---|
|
workspace_id
Required Type: string Identificador do workspace Ex: 4fHECmQtLdROI4fDLWMiLd |
|
|
Body Required Content Type: application/json |
||||||
|---|---|---|---|---|---|---|
|
||||||
1
2
3
4
5
{
"amount": 100.5,
"competency_month": 4,
"competency_year": 2025
}
Response
|
201 |
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Desconto aplicado com sucesso
|
||||||||||||
1
2
3
4
5
6
7
8
9
10
{
"success": true,
"applied_discount": 100.5,
"invoices": [
{
"invoice_id": "9c2f1f6e-1f0a-4a4c-9a3f-0d1b2c3d4e5f",
"amount": 100.5
}
]
}
|
401 |
||
|---|---|---|
|
Quando houver erro de autenticação
|
||
1
2
3
{
"errors": "Authentication Error, check your token and try again"
}
|
404 |
||
|---|---|---|
|
Recurso não encontrado. Possíveis motivos: - Nenhum cliente encontrado para o workspace informado - Nenhuma fatura emitida encontrada para o cliente na competência informada
|
||
1
2
3
{
"errors": "Cheque o Workspace ID e tente novamente mais tarde"
}
|
422 |
||
|---|---|---|
|
Erro de validação. Possíveis motivos: - Valor do desconto inválido (menor ou igual a zero) - Competência inválida ou não informada - Valor do desconto excede o total restante das faturas emitidas - Múltiplas faturas emitidas encontradas para a assinatura na competência
|
||
1
2
3
{
"errors": "Cheque o Workspace ID e tente novamente mais tarde"
}
|
500 |
||
|---|---|---|
|
Em caso de erro de servidor ou externo.
|
||
1
2
3
{
"errors": "Internal Server Error, please try again later."
}